Reframe generic Getting Started docs with multi-language-first wording#877
Reframe generic Getting Started docs with multi-language-first wording#877Copilot wants to merge 3 commits into
Conversation
Agent-Logs-Url: https://github.com/microsoft/aspire.dev/sessions/907fb32d-bab4-4c07-9f94-67a069a248c4 Co-authored-by: alistairmatthews <41286777+alistairmatthews@users.noreply.github.com>
| /> | ||
|
|
||
| At this point, the Aspire CLI has been installed and the ASP.NET Core development certificate has been created and trusted inside the Codespace. You can use `aspire new` right away without manually installing `Aspire.ProjectTemplates`. | ||
| At this point, the Aspire CLI has been installed and the local HTTPS development certificate for .NET workloads has been created and trusted inside the Codespace. You can use `aspire new` right away without manually installing `Aspire.ProjectTemplates`. |
There was a problem hiding this comment.
We should stay away from the workloads term. That has a meaning in .NET land and aspire used to have a .NET workload.
There was a problem hiding this comment.
Updated in 763ae9d: replaced for .NET workloads with for .NET apps to avoid workload terminology. Screenshot: /tmp/aspire-review-shots/.tmp-github-codespaces-review.png.
alistairmatthews
left a comment
There was a problem hiding this comment.
@copilot Please address my comments.
There was a problem hiding this comment.
For consistency, change the .NET logo to the C# equivalent, if there is one.
There was a problem hiding this comment.
Updated in 763ae9d: the C#-scoped AppHost Mermaid diagrams now use the C# logo token (logos:c-sharp) instead of .NET. Screenshot: /tmp/aspire-review-shots/.tmp-app-host-review.png.
| The basic Aspire Dev Container template works well for simple scenarios, but you might need additional configuration depending on your specific requirements. The following sections provide examples for various common scenarios. | ||
|
|
||
| ### Stateless .NET apps only | ||
| ### Stateless C#/.NET apps only |
There was a problem hiding this comment.
Adding "C#/" here doesn't change anything. Please revert to:
| ### Stateless C#/.NET apps only | |
| ### Stateless .NET apps only |
There was a problem hiding this comment.
Done in 763ae9d: reverted that heading to ### Stateless .NET apps only as suggested. Screenshot: /tmp/aspire-review-shots/.tmp-dev-containers-review.png.
Agent-Logs-Url: https://github.com/microsoft/aspire.dev/sessions/a6197f20-514c-44e5-9c61-01198699b4dd Co-authored-by: alistairmatthews <41286777+alistairmatthews@users.noreply.github.com>
Addressed in 763ae9d. All requested review comments are now applied and validated ( Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Updated the PR description so it does not contain any auto-closing keywords for #559, so merging this PR will not automatically close that issue. No code/UI changes were made in this update, so there is no screenshot. |
There was a problem hiding this comment.
Pull request overview
Reframes “Getting Started” documentation to use more multi-language-first wording across runtime prerequisites, template guidance, and AppHost architecture explanations.
Changes:
- Updates C# prerequisites copy to be more direct and language-first.
- Tweaks GitHub Codespaces wording around certificate setup.
- Expands template-selection guidance to explicitly mention additional language stacks.
- Adjusts AppHost architecture diagrams/wording to refer to “C# API” and changes the Mermaid icon used for the API.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/get-started/prerequisites.mdx | Rewords C# runtime prerequisite copy for clearer, language-first framing. |
| src/frontend/src/content/docs/get-started/github-codespaces.mdx | Updates wording describing HTTPS dev certificate setup in Codespaces. |
| src/frontend/src/content/docs/get-started/aspire-sdk-templates.mdx | Updates template guidance to call out multi-language starter options. |
| src/frontend/src/content/docs/get-started/app-host.mdx | Updates architecture description to “C# API” and changes Mermaid diagram icon for the API service. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| /> | ||
|
|
||
| At this point, the Aspire CLI has been installed and the ASP.NET Core development certificate has been created and trusted inside the Codespace. You can use `aspire new` right away without manually installing `Aspire.ProjectTemplates`. | ||
| At this point, the Aspire CLI has been installed and the local HTTPS development certificate for .NET apps has been created and trusted inside the Codespace. You can use `aspire new` right away without manually installing `Aspire.ProjectTemplates`. |
| ## Create solutions and projects using templates | ||
|
|
||
| To create an Aspire solution or project, use Visual Studio, Visual Studio Code, or the Aspire CLI, and base it on the available templates. Explore additional Aspire templates in the [Aspire samples](https://github.com/microsoft/aspire-samples) repository. | ||
| To create an Aspire solution or project, use Visual Studio, Visual Studio Code, or the Aspire CLI, and base it on the available templates. Choose the template that matches your app stack, including C#, TypeScript, Python, and JavaScript starter options. Explore additional Aspire templates in the [Aspire samples](https://github.com/microsoft/aspire-samples) repository. |
|
|
||
| service db(logos:postgresql)[PostgreSQL] | ||
| service api(logos:dotnet)[API service] | ||
| service api(logos:c-sharp)[API service] |
| service db(logos:postgresql)[pg] | ||
| service epr(iconoir:server-connection)[Endpoint Reference] | ||
| service api(logos:dotnet)[api] | ||
| service api(logos:c-sharp)[api] |
Uh oh!
There was an error while loading. Please reload this page.